MkPullRequestGuidelines
Node showing pull request guidelines.¶
Bases: MkTemplate
Name | Children | Inherits |
---|---|---|
MkTemplate mknodes.templatenodes.mktemplate Node representing a jinja template. |
graph TD
94599702798624["mkpullrequestguidelines.MkPullRequestGuidelines"]
94599704712992["mktemplate.MkTemplate"]
94599705096240["mkcontainer.MkContainer"]
94599705097232["mknode.MkNode"]
94599703461184["node.Node"]
140153667328480["builtins.object"]
94599704712992 --> 94599702798624
94599705096240 --> 94599704712992
94599705097232 --> 94599705096240
94599703461184 --> 94599705097232
140153667328480 --> 94599703461184
/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkpullrequestguidelines/metadata.toml
[metadata]
name = "MkPullRequestGuidelines"
icon = "octicon:git-pull-request-24"
group = "documentation"
# [examples.regular]
# title = "Regular"
# jinja = """
# {{ mk.MkPullRequestGuidelines() }}
# """
[output.markdown]
template = """
Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
{{ "git commit --fixup=SHA # SHA of commit you want to fix" | MkCode }}
Once all the changes are approved, you can squash your commits:
{{ "git rebase -i --autosquash main" | MkCode }}
And force-push:
{{ "git push -f" | MkCode }}
If this seems all too complicated, you can push or force-push each new commit,
and we will squash them ourselves if needed, before merging.
"""